<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="morsel-objects.html" />
<link rel="prev" href="module-Cookie.html" />
<link rel="parent" href="module-Cookie.html" />
<link rel="next" href="morsel-objects.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>18.23.1 Cookie Objects </title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.23 cookie  "
  href="module-Cookie.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18.23 cookie  "
  href="module-Cookie.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.23.2 morsel Objects"
  href="morsel-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-Cookie.html">18.23 Cookie  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-Cookie.html">18.23 Cookie  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="morsel-objects.html">18.23.2 Morsel Objects</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h2><a name="SECTION00202310000000000000000"></a><a name="cookie-objects"></a>
<br>
18.23.1 Cookie Objects 
</h2>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4429' xml:id='l2h-4429' class="method">value_decode</tt></b>(</nobr></td>
  <td><var>val</var>)</td></tr></table></dt>
<dd>
Return a decoded value from a string representation. Return value can
be any type. This method does nothing in <tt class="class">BaseCookie</tt> -- it exists
so it can be overridden.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4430' xml:id='l2h-4430' class="method">value_encode</tt></b>(</nobr></td>
  <td><var>val</var>)</td></tr></table></dt>
<dd>
Return an encoded value. <var>val</var> can be any type, but return value
must be a string. This method does nothing in <tt class="class">BaseCookie</tt> -- it exists
so it can be overridden

<p>
In general, it should be the case that <tt class="method">value_encode()</tt> and 
<tt class="method">value_decode()</tt> are inverses on the range of <var>value_decode</var>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4431' xml:id='l2h-4431' class="method">output</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>attrs</var><big>[</big><var>, header</var><big>[</big><var>, sep</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return a string representation suitable to be sent as HTTP headers.
<var>attrs</var> and <var>header</var> are sent to each <tt class="class">Morsel</tt>'s
<tt class="method">output()</tt> method. <var>sep</var> is used to join the headers
together, and is by default the combination <code>'\r\n'</code> (CRLF).

<span class="versionnote">Changed in version 2.5:
The default separator has been changed from <code>'\n'</code>
to match the cookie specification.</span>

</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4432' xml:id='l2h-4432' class="method">js_output</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>attrs</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return an embeddable JavaScript snippet, which, if run on a browser which
supports JavaScript, will act the same as if the HTTP headers was sent.

<p>
The meaning for <var>attrs</var> is the same as in <tt class="method">output()</tt>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4433' xml:id='l2h-4433' class="method">load</tt></b>(</nobr></td>
  <td><var>rawdata</var>)</td></tr></table></dt>
<dd>
If <var>rawdata</var> is a string, parse it as an <code>HTTP_COOKIE</code> and add
the values found there as <tt class="class">Morsel</tt>s. If it is a dictionary, it
is equivalent to:

<p>
<div class="verbatim"><pre>
for k, v in rawdata.items():
    cookie[k] = v
</pre></div>
</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.23 cookie  "
  href="module-Cookie.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18.23 cookie  "
  href="module-Cookie.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.23.2 morsel Objects"
  href="morsel-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-Cookie.html">18.23 Cookie  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-Cookie.html">18.23 Cookie  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="morsel-objects.html">18.23.2 Morsel Objects</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
